Update DB-API instrumentor readthedocs with sqlcommenter guide #3720
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tammy-baylis-swi
changed the title
...tion/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapi/__init__.py
Show resolved
Hide resolved
emdneto
approved these changes
Sep 1, 2025
...tion/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapi/__init__.py
Outdated
Show resolved
Hide resolved
tammy-baylis-swi
moved this to Easy to review / merge / close
in @xrmx's Python PR digest
...tion/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapi/__init__.py
Outdated
Show resolved
Hide resolved
...tion/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapi/__init__.py
Outdated
Show resolved
Hide resolved
JWinermaSplunk
approved these changes
Sep 15, 2025
xrmx
approved these changes
Oct 10, 2025
xrmx
moved this from Easy to review / merge / close
to Approved PRs
in @xrmx's Python PR digest
github-project-automation
bot
moved this from Approved PRs
to Done
in @xrmx's Python PR digest
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updates the DB-API instrumentor readthedocs with sqlcommenter information. Adds encouragement to use concrete db client framework/ORM instrumentors instead, if they exist (e.g. psycopg2, mysqlclient, etc).
Changes and suggestions here will be the "foundation" for fixing the readthedocs of those concrete instrumentors later in another PR.
Partially fixes #3162
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
tox -e docsdocs/_build/html/instrumentation/dbapi/dbapi.htmlDoes This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.